com.inscoper.nbo.WellSample¶

Represents the XML element WellSample. More...

Inherits from com.inscoper.nbo.NBOBaseClass

Public Functions¶

	Name
synchronized void	delete()
	WellSample()
String	getTypeName() Returns the class type name.
String	getXMLName() Returns the XML element name corresponding to this class.
ENBOType	getNBOType() Returns the NBO Type corresponding to this class.
NBOBaseClassVector	getChildren() Returns a list of all classes derived from this class.
NBOBaseClassVector	getSubElements() Returns a list of all child elements contained in this class.
void	fromJsonFile(String path, boolean validate) Populates this object from a JSON file.
void	fromJsonFile(String path) Populates this object from a JSON file.
void	fromJsonString(String json_string, boolean validate) Populates this object from a JSON string.
void	fromJsonString(String json_string) Populates this object from a JSON string.
void	fromXmlFile(String path, boolean validate) Populates this object from a XML file.
void	fromXmlFile(String path) Populates this object from a XML file.
void	fromXmlString(String xml_string, boolean validate) Populates this object from a XML string.
void	fromXmlString(String xml_string) Populates this object from a XML string.
void	toXmlFile(String filename, boolean validate) Serializes this object to an XML file.
void	toXmlFile(String filename) Serializes this object to an XML file.
String	toXmlString(boolean validate) Serializes this object to an XML string.
String	toXmlString() Serializes this object to an XML string.
void	setID(WellSampleID_Type value, boolean validate) Sets the value of the ID attribute.
void	setID(WellSampleID_Type value) Sets the value of the ID attribute.
WellSampleID_Type	getID() Returns the value of the ID attribute.
void	resetID() Resets the ID attribute to an unset state.
boolean	hasID() Checks whether the optional ID attribute is present.
void	setPositionX(float value, boolean validate) Sets the value of the PositionX attribute.
void	setPositionX(float value) Sets the value of the PositionX attribute.
float	getPositionX() Returns the value of the PositionX attribute.
void	resetPositionX() Resets the PositionX attribute to an unset state.
boolean	hasPositionX() Checks whether the PositionX attribute is present.
void	setPositionXUnit(UnitsLength_Type value, boolean validate) Sets the value of the PositionXUnit attribute.
void	setPositionXUnit(UnitsLength_Type value) Sets the value of the PositionXUnit attribute.
UnitsLength_Type	getPositionXUnit() Returns the value of the PositionXUnit attribute.
void	resetPositionXUnit() Resets the PositionXUnit attribute to an unset state.
boolean	hasPositionXUnit() Checks whether the optional PositionXUnit attribute is present.
void	setPositionY(float value, boolean validate) Sets the value of the PositionY attribute.
void	setPositionY(float value) Sets the value of the PositionY attribute.
float	getPositionY() Returns the value of the PositionY attribute.
void	resetPositionY() Resets the PositionY attribute to an unset state.
boolean	hasPositionY() Checks whether the PositionY attribute is present.
void	setPositionYUnit(UnitsLength_Type value, boolean validate) Sets the value of the PositionYUnit attribute.
void	setPositionYUnit(UnitsLength_Type value) Sets the value of the PositionYUnit attribute.
UnitsLength_Type	getPositionYUnit() Returns the value of the PositionYUnit attribute.
void	resetPositionYUnit() Resets the PositionYUnit attribute to an unset state.
boolean	hasPositionYUnit() Checks whether the optional PositionYUnit attribute is present.
void	setTimepoint(String value, boolean validate) Sets the value of the Timepoint attribute.
void	setTimepoint(String value) Sets the value of the Timepoint attribute.
String	getTimepoint() Returns the value of the Timepoint attribute.
void	resetTimepoint() Resets the Timepoint attribute to an unset state.
boolean	hasTimepoint() Checks whether the Timepoint attribute is present.
void	setIndex(NonNegativeInt_Type value, boolean validate) Sets the value of the Index attribute.
void	setIndex(NonNegativeInt_Type value) Sets the value of the Index attribute.
NonNegativeInt_Type	getIndex() Returns the value of the Index attribute.
void	resetIndex() Resets the Index attribute to an unset state.
boolean	hasIndex() Checks whether the optional Index attribute is present.
void	setImageRef(ImageRef value, boolean validate) Sets the value of the ImageRef element.
void	setImageRef(ImageRef value) Sets the value of the ImageRef element.
ImageRef	getImageRef() Returns the value of the ImageRef element.
void	resetImageRef() Resets the ImageRef element to an unset state.
boolean	hasImageRef() Checks whether the optional ImageRef element is present.
WellSample	__internal_create(long cPtr, boolean own)
WellSample	fromBase(NBOBaseClass base) Cast a NBOBaseClass to a CMOS.
StringSet	getTimepointAllowedValues() Returns the allowed values for this attribut.

Protected Functions¶

	Name
	WellSample(long cPtr, boolean cMemoryOwn)
void	swigSetCMemOwn(boolean own)
void	finalize()
long	getCPtr(WellSample obj)

Additional inherited members¶

Protected Functions inherited from com.inscoper.nbo.NBOBaseClass

	Name
	NBOBaseClass(long cPtr, boolean cMemoryOwn)

Detailed Description¶

public class com.inscoper.nbo.WellSample;

Represents the XML element WellSample.

WellSample is an individual Image that has been captured within a Well.

Public Functions Documentation¶

function delete¶

public synchronized void delete()

Reimplements: com.inscoper.nbo.NBOBaseClass.delete

function WellSample¶

public WellSample()

function getTypeName¶

public String getTypeName()

Returns the class type name.

Return: The class type name

Reimplements: com.inscoper.nbo.NBOBaseClass.getTypeName

function getXMLName¶

public String getXMLName()

Returns the XML element name corresponding to this class.

Return: The XML element name

Reimplements: com.inscoper.nbo.NBOBaseClass.getXMLName

function getNBOType¶

public ENBOType getNBOType()

Returns the NBO Type corresponding to this class.

Return: The NBO Type value

Reimplements: com.inscoper.nbo.NBOBaseClass.getNBOType

function getChildren¶

public NBOBaseClassVector getChildren()

Returns a list of all classes derived from this class.

Return: The list of derived classes

Reimplements: com.inscoper.nbo.NBOBaseClass.getChildren

function getSubElements¶

public NBOBaseClassVector getSubElements()

Returns a list of all child elements contained in this class.

Return: The list of child classes

Reimplements: com.inscoper.nbo.NBOBaseClass.getSubElements

function fromJsonFile¶

public void fromJsonFile(
    String path,
    boolean validate
)

Populates this object from a JSON file.

Parameters:

path The path to the JSON file
validate If true, validates constraints on value. Default is true.

function fromJsonFile¶

public void fromJsonFile(
    String path
)

Populates this object from a JSON file.

Parameters:

path The path to the JSON file

function fromJsonString¶

public void fromJsonString(
    String json_string,
    boolean validate
)

Populates this object from a JSON string.

Parameters:

json_string The JSON content as a string
validate If true, validates constraints on value. Default is true.

function fromJsonString¶

public void fromJsonString(
    String json_string
)

Populates this object from a JSON string.

Parameters:

json_string The JSON content as a string

function fromXmlFile¶

public void fromXmlFile(
    String path,
    boolean validate
)

Populates this object from a XML file.

Parameters:

path The path to the XML file
validate If true, validates constraints on value. Default is true.

function fromXmlFile¶

public void fromXmlFile(
    String path
)

Populates this object from a XML file.

Parameters:

path The path to the XML file

function fromXmlString¶

public void fromXmlString(
    String xml_string,
    boolean validate
)

Populates this object from a XML string.

Parameters:

xml_string The XML content as a string
validate If true, validates constraints on value. Default is true.

function fromXmlString¶

public void fromXmlString(
    String xml_string
)

Populates this object from a XML string.

Parameters:

xml_string The XML content as a string

function toXmlFile¶

public void toXmlFile(
    String filename,
    boolean validate
)

Serializes this object to an XML file.

Parameters:

filename The path to the output XML file
validate If true, validates constraints on value. Default is true.

function toXmlFile¶

public void toXmlFile(
    String filename
)

Serializes this object to an XML file.

Parameters:

filename The path to the output XML file

function toXmlString¶

public String toXmlString(
    boolean validate
)

Serializes this object to an XML string.

Parameters:

validate If true, validates constraints on value. Default is true.

Return: A string containing the XML representation of this object

function toXmlString¶

public String toXmlString()

Serializes this object to an XML string.

Return: A string containing the XML representation of this object

function setID¶

public void setID(
    WellSampleID_Type value,
    boolean validate
)

Sets the value of the ID attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setID¶

public void setID(
    WellSampleID_Type value
)

Sets the value of the ID attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getID¶

public WellSampleID_Type getID()

Returns the value of the ID attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetID¶

public void resetID()

Resets the ID attribute to an unset state.

No description available in the XSD standard.

function hasID¶

public boolean hasID()

Checks whether the optional ID attribute is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setPositionX¶

public void setPositionX(
    float value,
    boolean validate
)

Sets the value of the PositionX attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

The X position of the field (Image) within the well relative to the well origin defined on the Plate. Units are set by PositionXUnit.

function setPositionX¶

public void setPositionX(
    float value
)

Sets the value of the PositionX attribute.

Parameters:

value The value to set

The X position of the field (Image) within the well relative to the well origin defined on the Plate. Units are set by PositionXUnit.

function getPositionX¶

public float getPositionX()

Returns the value of the PositionX attribute.

Return: The value of the attribute

The X position of the field (Image) within the well relative to the well origin defined on the Plate. Units are set by PositionXUnit.

function resetPositionX¶

public void resetPositionX()

Resets the PositionX attribute to an unset state.

The X position of the field (Image) within the well relative to the well origin defined on the Plate. Units are set by PositionXUnit.

function hasPositionX¶

public boolean hasPositionX()

Checks whether the PositionX attribute is present.

Return: true if the attribute has been set, false otherwise

The X position of the field (Image) within the well relative to the well origin defined on the Plate. Units are set by PositionXUnit.

function setPositionXUnit¶

public void setPositionXUnit(
    UnitsLength_Type value,
    boolean validate
)

Sets the value of the PositionXUnit attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setPositionXUnit¶

public void setPositionXUnit(
    UnitsLength_Type value
)

Sets the value of the PositionXUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getPositionXUnit¶

public UnitsLength_Type getPositionXUnit()

Returns the value of the PositionXUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetPositionXUnit¶

public void resetPositionXUnit()

Resets the PositionXUnit attribute to an unset state.

No description available in the XSD standard.

function hasPositionXUnit¶

public boolean hasPositionXUnit()

Checks whether the optional PositionXUnit attribute is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setPositionY¶

public void setPositionY(
    float value,
    boolean validate
)

Sets the value of the PositionY attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

The Y position of the field (Image) within the well relative to the well origin defined on the Plate. Units are set by PositionYUnit.

function setPositionY¶

public void setPositionY(
    float value
)

Sets the value of the PositionY attribute.

Parameters:

value The value to set

The Y position of the field (Image) within the well relative to the well origin defined on the Plate. Units are set by PositionYUnit.

function getPositionY¶

public float getPositionY()

Returns the value of the PositionY attribute.

Return: The value of the attribute

The Y position of the field (Image) within the well relative to the well origin defined on the Plate. Units are set by PositionYUnit.

function resetPositionY¶

public void resetPositionY()

Resets the PositionY attribute to an unset state.

The Y position of the field (Image) within the well relative to the well origin defined on the Plate. Units are set by PositionYUnit.

function hasPositionY¶

public boolean hasPositionY()

Checks whether the PositionY attribute is present.

Return: true if the attribute has been set, false otherwise

The Y position of the field (Image) within the well relative to the well origin defined on the Plate. Units are set by PositionYUnit.

function setPositionYUnit¶

public void setPositionYUnit(
    UnitsLength_Type value,
    boolean validate
)

Sets the value of the PositionYUnit attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setPositionYUnit¶

public void setPositionYUnit(
    UnitsLength_Type value
)

Sets the value of the PositionYUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getPositionYUnit¶

public UnitsLength_Type getPositionYUnit()

Returns the value of the PositionYUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetPositionYUnit¶

public void resetPositionYUnit()

Resets the PositionYUnit attribute to an unset state.

No description available in the XSD standard.

function hasPositionYUnit¶

public boolean hasPositionYUnit()

Checks whether the optional PositionYUnit attribute is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setTimepoint¶

public void setTimepoint(
    String value,
    boolean validate
)

Sets the value of the Timepoint attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

The time-point at which the Image started to be collected

function setTimepoint¶

public void setTimepoint(
    String value
)

Sets the value of the Timepoint attribute.

Parameters:

value The value to set

The time-point at which the Image started to be collected

function getTimepoint¶

public String getTimepoint()

Returns the value of the Timepoint attribute.

Return: The value of the attribute

The time-point at which the Image started to be collected

function resetTimepoint¶

public void resetTimepoint()

Resets the Timepoint attribute to an unset state.

The time-point at which the Image started to be collected

function hasTimepoint¶

public boolean hasTimepoint()

Checks whether the Timepoint attribute is present.

Return: true if the attribute has been set, false otherwise

The time-point at which the Image started to be collected

function setIndex¶

public void setIndex(
    NonNegativeInt_Type value,
    boolean validate
)

Sets the value of the Index attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

This records the order of the well samples. Each index should be unique for a given plate but they do not have to be sequential, there may be gaps if part of the dataset is missing. In the user interface the displayed value of the index will be calculated modulo the number of PlateAcquisitions for the plate.

function setIndex¶

public void setIndex(
    NonNegativeInt_Type value
)

Sets the value of the Index attribute.

Parameters:

value The value to set

This records the order of the well samples. Each index should be unique for a given plate but they do not have to be sequential, there may be gaps if part of the dataset is missing. In the user interface the displayed value of the index will be calculated modulo the number of PlateAcquisitions for the plate.

function getIndex¶

public NonNegativeInt_Type getIndex()

Returns the value of the Index attribute.

Return: The value of the attribute

This records the order of the well samples. Each index should be unique for a given plate but they do not have to be sequential, there may be gaps if part of the dataset is missing. In the user interface the displayed value of the index will be calculated modulo the number of PlateAcquisitions for the plate.

function resetIndex¶

public void resetIndex()

Resets the Index attribute to an unset state.

This records the order of the well samples. Each index should be unique for a given plate but they do not have to be sequential, there may be gaps if part of the dataset is missing. In the user interface the displayed value of the index will be calculated modulo the number of PlateAcquisitions for the plate.

function hasIndex¶

public boolean hasIndex()

Checks whether the optional Index attribute is present.

Return: true if the optional attribute has been set, false otherwise

This records the order of the well samples. Each index should be unique for a given plate but they do not have to be sequential, there may be gaps if part of the dataset is missing. In the user interface the displayed value of the index will be calculated modulo the number of PlateAcquisitions for the plate.

function setImageRef¶

public void setImageRef(
    ImageRef value,
    boolean validate
)

Sets the value of the ImageRef element.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

This is the main link to the core Image element

function setImageRef¶

public void setImageRef(
    ImageRef value
)

Sets the value of the ImageRef element.

Parameters:

value The value to set

This is the main link to the core Image element

function getImageRef¶

public ImageRef getImageRef()

Returns the value of the ImageRef element.

Return: The value of the element

This is the main link to the core Image element

function resetImageRef¶

public void resetImageRef()

Resets the ImageRef element to an unset state.

This is the main link to the core Image element

function hasImageRef¶

public boolean hasImageRef()

Checks whether the optional ImageRef element is present.

Return: true if the optional attribute has been set, false otherwise

This is the main link to the core Image element

function __internal_create¶

public static WellSample __internal_create(
    long cPtr,
    boolean own
)

Reimplements: com.inscoper.nbo.NBOBaseClass.__internal_create

function fromBase¶

public static WellSample fromBase(
    NBOBaseClass base
)

Cast a NBOBaseClass to a CMOS.

Parameters:

base The base class to cast

Return: The casted element, or nullptr if the cast fails

function getTimepointAllowedValues¶

public static StringSet getTimepointAllowedValues()

Returns the allowed values for this attribut.

Return: The list of allowed values

The time-point at which the Image started to be collected

Protected Functions Documentation¶

function WellSample¶

protected WellSample(
    long cPtr,
    boolean cMemoryOwn
)

function swigSetCMemOwn¶

protected void swigSetCMemOwn(
    boolean own
)

Reimplements: com.inscoper.nbo.NBOBaseClass.swigSetCMemOwn

function finalize¶

protected void finalize()

Reimplements: com.inscoper.nbo.NBOBaseClass.finalize

function getCPtr¶

protected static long getCPtr(
    WellSample obj
)

Updated on 2026-06-22 at 17:06:33 +0200